home *** CD-ROM | disk | FTP | other *** search
/ Megarom / Megarom Macintosh CD Software (Quantum Leap)(1992).iso / COMMUNICATION / Zmodem Sources / rz.1 < prev    next >
Text File  |  1989-03-14  |  7KB  |  288 lines
  1. '\" Revision Level 
  2. '\" Last Delta     05-28-87
  3. .TH RZ 1 OMEN
  4. .SH NAME
  5. rx, rb, rz \- XMODEM, YMODEM, ZMODEM (Batch) file receive
  6. .SH SYNOPSIS
  7. .B rz
  8. .RB [\- "\ +1abepqtuv" ]
  9. .br
  10. .B rb
  11. .RB [\- "\ +1abqtuv" ]
  12. .br
  13. .B rz
  14. .RB [\- "\ 1abceqtuv" ]
  15. .I file
  16. .br
  17. .B gz
  18. .I "file ..."
  19. .br
  20. .RB [ \- ][ v ] rzCOMMAND
  21. .SH DESCRIPTION
  22. This program uses error correcting protocol to receive
  23. files over a serial port from a variety of programs running under
  24. PC-DOS, CP/M,
  25. .SM Unix,
  26. and other operating systems.
  27.  
  28. The first form of
  29. .I rz
  30. (Receive ZMODEM)
  31. receives files with the ZMODEM batch protocol.
  32. If the sending program does not support ZMODEM,
  33. .I rz
  34. steps down to YMODEM protocol
  35. after 50 seconds.
  36. This delay can be eliminated by invoking the program as
  37. .I rb .
  38.  
  39. When receiving with XMODEM or YMODEM,
  40. .I Rz
  41. accepts either standard 128 byte sectors or
  42. 1024 byte sectors
  43. (YAM
  44. .B -k
  45. option).
  46. The user should determine when
  47. the longer block length
  48. actually improves throughput without causing problems.
  49.  
  50. If extended file information (file length, etc.)
  51. is received,
  52. the file length controls the number of bytes written to
  53. the output dataset (YMODEM only),
  54. and the modify time and file mode
  55. (iff non zero)
  56. are set accordingly.
  57.  
  58. If no extended file information is received,
  59. slashes in the pathname are changed to underscore,
  60. and any trailing period in the pathname is eliminated.
  61. This conversion is useful for files received from CP/M systems.
  62. With YMODEM, each file name is converted to lower case
  63. unless it contains one or more lower case letters.
  64.  
  65.  
  66. The second form of
  67. .I rz
  68. receives a single
  69. .I file
  70. with XMODEM protocol.
  71. The user must supply the file name to both sending and receiving programs.
  72.  
  73. .I Gz
  74. is a shell script which calls
  75. .I sz
  76. to command Pro-YAM or ZCOMM to transmit the specified files.
  77. Pathnames used with
  78. .I gz
  79. must be escaped if they have special significance to the Unix shell.
  80. .br
  81. EXAMPLE:
  82. gz "-a C:*.c D:*.h"
  83.  
  84.  
  85. The third form of
  86. .I rz
  87. is invoked as
  88. .B rzCOMMAND
  89. (with an optional leading \- as generated by login(1)).
  90. For each received file,
  91. rz will pipe the file to ``COMMAND filename''
  92. where filename is the name of the transmitted file
  93. with the file contents as standard input.
  94.  
  95. Each file transfer is acknowledged when COMMAND exits with 0 status.
  96. A non zero exit status terminates transfers.
  97.  
  98. A typical use for this form is
  99. .I rzrmail
  100. which calls rmail(1)
  101. to post mail to the user specified by the transmitted file name.
  102. For example, sending the file "caf" from a PC-DOS system to
  103. .I rzrmail
  104. on a
  105. .SM Unix
  106. system
  107. would result in the contents of the DOS file "caf" being mailed to user "caf".
  108.  
  109. On some
  110. .SM Unix
  111. systems, the login directory must contain a link to
  112. COMMAND as login sets SHELL=rsh which disallows absolute
  113. pathnames.
  114. If invoked with a leading ``v'',
  115. .I rz
  116. will report progress to /tmp/rzlog.
  117. The following entry works for
  118. .SM Unix
  119. 3.0:
  120. .ce
  121. rzrmail::5:1::/bin:/usr/local/rzrmail
  122. If the SHELL environment variable includes
  123. .I "rsh"
  124. or
  125. .I "rksh"
  126. (restricted shell),
  127. rz will not accept absolute pathnames
  128. or references to a parent directory,
  129. will not modify an existing file, and
  130. removes any files received in error.
  131.  
  132. If
  133. .B rz
  134. is invoked with stdout and stderr to different datasets,
  135. Verbose is set to 2, causing frame by frame progress reports
  136. to stderr.
  137. This may be disabled with the
  138. .B q
  139. option.
  140.  
  141. .PP
  142. The meanings of the available options are:
  143. .PP
  144. .PD 0
  145. .TP
  146. .B 1
  147. Use file descriptor 1 for ioctls and reads (Unix only).
  148. By default, file descriptor 0 is used for ioctls and reads.
  149. This option allows
  150. .B rz
  151. to be used with the
  152. .I Professional-YAM
  153. .B $
  154. command
  155. and some versions of ncu(1).
  156. .TP
  157. .B a
  158. Convert files to
  159. .SM Unix
  160. conventions by stripping carriage returns and all characters
  161. beginning with the first Control Z (CP/M end of file).
  162. .TP
  163. .B b
  164. Binary
  165. (tell it like it is)
  166. file transfer override.
  167. .TP
  168. .B c
  169. Request 16 bit CRC.
  170. XMODEM file transfers default to 8 bit checksum.
  171. YMODEM and ZMODEM normally use 16 bit CRC.
  172. .TP
  173. .B D
  174. Output file data to /dev/null; for testing.
  175. .TP
  176. .B e
  177. Force sender to escape all control characters;
  178. normally XON, XOFF, DLE, CR-@-CR, and Ctrl-X are escaped.
  179. .TP
  180. .B p
  181. (ZMODEM) Protect: skip file if destination file exists.
  182. .TP
  183. .B q
  184. Quiet suppresses verbosity.
  185. .TP
  186. .B "t tim"
  187. Change timeout to
  188. .I tim
  189. tenths of seconds.
  190. .TP
  191. .B v
  192. Verbose
  193. causes a list of file
  194. names to be appended to
  195. /tmp/rzlog .
  196. More v's generate more output.
  197. .PD
  198. .ne 6
  199. .SH EXAMPLES
  200. .RE
  201. (Pro-YAM command)
  202. .RS
  203. .I <ALT-2>
  204. .br
  205. Pro-YAM Command:
  206. .I "sz *.h *.c"
  207. .br
  208. (This automatically invokes
  209. .I rz
  210. on the connected system.)
  211. .RE
  212. .SH SEE ALSO
  213. ZMODEM.DOC,
  214. YMODEM.DOC,
  215. IMP(CP/M),
  216. Professional-YAM,
  217. sz(omen),
  218. usq(omen),
  219. undos(omen)
  220.  
  221. Compile time options required
  222. for various operating systems are described in the
  223. source file.
  224. .SH NOTES
  225. The Unix "ulimit" parameter must be set high enough
  226. to permit large file transfers.
  227.  
  228. The TTY input buffering on some systems may not allow long blocks
  229. or streaming input at high speed.
  230. You should suspect this problem when you
  231. can't send data to the Unix system at high speeds using ZMODEM
  232. when YMODEM with 128 byte blocks works properly.
  233. If the system's tty line handling is really broken, the serial port
  234. or the entire system may not survive the onslaught of long bursts
  235. of high speed data.
  236.  
  237. The DSZ or Pro-YAM
  238. .B "zmodem l"
  239. numeric parameter may be set to a value between 64 and 1024 to limit the
  240. burst length ("zmodem pl128").
  241.  
  242. 32 bit CRC code courtesy Gary S. Brown.
  243. .SH BUGS
  244. Calling
  245. .I rz
  246. from most versions of cu(1) doesn't work because cu's receive process
  247. fights
  248. .I rz
  249. for characters from the modem.
  250.  
  251. Pathnames are restricted to 127 characters.
  252. In XMODEM single file mode, the pathname given on the command line
  253. is still processed as described above.
  254. The ASCII option\'s CR/LF to NL translation merely deletes CR\'s;
  255. undos(omen) performs a more intelligent translation.
  256. .SH "VMS VERSION"
  257. Some of the #includes with file names enclosed with angle brackets <>
  258. may need to have the angle brackets changed to "", or vice versa.
  259.  
  260. The VMS version does not set binary mode according to the incoming
  261. file type.
  262. Non binary file processing consists of stripping all characters beginning
  263. with CPMEOF (^Z).
  264.  
  265. The VMS version does not set the file time.
  266.  
  267. At high speeds,
  268. VMS sometimes loses incoming characters, resulting in retries
  269. and degradation of throughput.
  270.  
  271. The mysterious
  272. VMS C Standard I/O Package and RMS may interact to modify
  273. file contents unexpectedly.
  274.  
  275. The VMS version does not support invocation as
  276. .B rzCOMMAND .
  277. ZMODEM has not yet been implemented on the VMS version.
  278. .SH "ZMODEM CAPABILITIES"
  279. .I Rz
  280. supports incoming ZMODEM binary (-b), ASCII (-a),
  281. protect (-p),
  282. and append (-+)
  283. requests, and ZMODEM command execution.
  284. .SH FILES
  285. rz.c, rbsb.c, zm.c, zmodem.h source files.
  286.  
  287. /tmp/rzlog stores debugging output generated with -vv option.
  288.